/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.test.runner.intercepting;

import android.app.Activity;
import android.content.Intent;

/**
 * Implement this interface to provide custom implementation of Activity under test. It is used by
 * {@link androidx.test.runner.MonitoringInstrumentation#newActivity(ClassLoader, String, Intent)}
 * to create instance of the activity under test. Please see {@link
 * androidx.test.runner.MonitoringInstrumentation#interceptActivityUsing(InterceptingActivityFactory)}
 * for more details.
 *
 * @deprecated use {@link androidx.test.ext.junit.rules.AppComponentFactoryRule} instead.
 */
@Deprecated
public interface InterceptingActivityFactory {

  /**
   * This method can be used to know whether activity instance creation should be intercepted or not
   * for a particular activity in response to a given intent.
   *
   * @param classLoader The ClassLoader with which to instantiate the object
   * @param className The name of the class implementing the Activity object
   * @param intent The Intent object that specified the activity class being instantiated.
   * @return true if activity with className should be intercepted, otherwise false.
   */
  boolean shouldIntercept(ClassLoader classLoader, String className, Intent intent);

  /**
   * This method can be used to provide activity instance while intercepting activity creation for a
   * particular activity in response to a given intent.
   *
   * @param classLoader The ClassLoader with which to instantiate the object
   * @param className The name of the class implementing the Activity object
   * @param intent The Intent object that specified the activity class being instantiated.
   * @return The newly instantiated Activity object.
   */
  Activity create(ClassLoader classLoader, String className, Intent intent);
}
